feat: add sdk-core vault module interfaces and scaffolding#9198
Merged
davidkaplanbitgo merged 2 commits intoJul 9, 2026
Merged
Conversation
Contributor
davidkaplanbitgo
force-pushed
the
WCN-1192.vault-interfaces
branch
from
009db3a to
14e320a
Compare
davidkaplanbitgo
requested review from
OttoAllmendinger,
lokesh-bitgo and
zahin-mohammad
| bitgoNitroChallenge: SerializedNtildeWithVerifiers | ||
| ): Promise<void>; | ||
| hasFeatureFlags(flags: EnterpriseFeatureFlag[]): boolean; | ||
| vaults(): IVaults; |
Contributor
There was a problem hiding this comment.
Lets add an @experimental jsdoc, in case we need to make breaking changes before the public release.
| // whole-vault: view/admin/spend; spend opens a key share (also how a spender services a | ||
| // vaultShareRequests entry in UMS orgs) | ||
| addMember(params: AddVaultMemberOptions): Promise<VaultData>; | ||
| // share ONE vault wallet (FR-13), not the whole vault |
Contributor
There was a problem hiding this comment.
Suggested change
| // share ONE vault wallet (FR-13), not the whole vault | |
| // share ONE vault wallet, not the whole vault |
|
|
||
| export interface IVaults { | ||
| // orchestrates: initialize → 4 root key flows (vaultId-tagged) → finalize → keycard | ||
| createVault(params: CreateVaultOptions): Promise<Vault>; |
Contributor
There was a problem hiding this comment.
Suggested change
| createVault(params: CreateVaultOptions): Promise<Vault>; | |
| createVaultKeys(params: CreateVaultOptions): Promise<Vault>; |
Comment on lines
+31
to
+33
| createVault(params: CreateVaultOptions): Promise<Vault>; | ||
| initializeVault(params: InitializeVaultOptions): Promise<Vault>; | ||
| finalizeVault(vaultId: string, params: FinalizeVaultOptions): Promise<Vault>; |
Contributor
There was a problem hiding this comment.
Suggested change
| createVault(params: CreateVaultOptions): Promise<Vault>; | |
| initializeVault(params: InitializeVaultOptions): Promise<Vault>; | |
| finalizeVault(vaultId: string, params: FinalizeVaultOptions): Promise<Vault>; | |
| initializeVault(params: InitializeVaultOptions): Promise<Vault>; | |
| createVaultKeys(params: CreateVaultOptions & VaultCreationPhase1): Promise<VaultKeys>; | |
| finalizeVault(vaultId: string, params: FinalizeVaultOptions & VaultKeys): Promise<Vault>; |
Not a concrete suggestion, but I think we can do something with the types to make the flow of sdk calls more intuitive.
should we also have a generateVault that is a convenience wrapper around all 3 calls?
|
|
||
| export class Vault implements IVault { | ||
| private readonly bitgo: BitGoBase; | ||
| private readonly baseCoin: IBaseCoin; |
Contributor
There was a problem hiding this comment.
Hm a vault is multicoin, so not sure what we would do with this singular coin class?
lcovar
previously approved these changes
Jul 8, 2026
OttoAllmendinger
requested changes
Jul 9, 2026
davidkaplanbitgo
force-pushed
the
WCN-1192.vault-interfaces
branch
from
1971257 to
83dcf33
Compare
davidkaplanbitgo
changed the base branch from
master
to
WCN-1192.extend-abstract-utxo-timeout
Net-new sdk-core/src/bitgo/vault module mirroring the EnterpriseData/ Enterprise and WalletData/Wallet conventions: iVault/iVaults interfaces (per API Changes v1 §3), the Vault and Vaults classes, and the barrel. Vault implements getters, url(), toJSON(), and freeze/archive REST plumbing; createWallet, member, and share methods are stubbed for WCN-1203/WCN-1204. Vaults lifecycle methods (createVault, initialize, finalize, list, get) are stubbed pending Phase 2/3 (WCN-1175/1177). Wires an Enterprise.vaults() accessor and the bitgo barrel export. WCN-1192 TICKET: WCN-1192
davidkaplanbitgo
force-pushed
the
WCN-1192.vault-interfaces
branch
from
83dcf33 to
4a87ebf
Compare
zahin-mohammad
approved these changes
Jul 9, 2026
| * - eddsaMpc ③ — ex. SOL/SUI/NEAR/TON/APT/DOT | ||
| * - ed25519Multisig ④ — ex. ALGO/XLM/HBAR | ||
| */ | ||
| export const RootKeyType = t.keyof( |
Contributor
There was a problem hiding this comment.
Once we finalize, we should consider moving these codecs to public-types. Having it in the sdk for now is fine though.
| id: t.string, | ||
| enterpriseId: t.string, | ||
| label: t.string, | ||
| // freeze is NOT a status — a frozen vault stays 'active' with the freeze field set (wallet precedent) |
Contributor
There was a problem hiding this comment.
Suggested change
| // freeze is NOT a status — a frozen vault stays 'active' with the freeze field set (wallet precedent) |
| /** POST /enterprise/:eId/vaults/:vId/finalize — the 12 key ids as 4 ordered triplets. */ | ||
| export const FinalizeVaultBody = t.type({ rootKeys: VaultRootKeys }, 'FinalizeVaultBody'); | ||
|
|
||
| /** POST/DELETE /enterprise/:eId/vaults/:vId/freeze */ |
Contributor
There was a problem hiding this comment.
Suggested change
| /** POST/DELETE /enterprise/:eId/vaults/:vId/freeze */ | |
| /** POST /enterprise/:eId/vaults/:vId/freeze */ |
| status(): VaultData['status']; | ||
| url(extra?: string): string; | ||
| createWallet(params: CreateVaultWalletOptions): Promise<Wallet>; | ||
| // whole-vault: view/admin/spend; spend opens a key share (also how a spender services a |
Contributor
There was a problem hiding this comment.
Suggested change
| // whole-vault: view/admin/spend; spend opens a key share (also how a spender services a | |
| // whole-vault: view/admin/spend/dapp; spend opens a key share (also how a spender services a |
davidkaplanbitgo
merged commit 1ac89a2
into
WCN-1192.extend-abstract-utxo-timeout
6 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Net-new sdk-core/src/bitgo/vault module mirroring the EnterpriseData/ Enterprise and WalletData/Wallet conventions: iVault/iVaults interfaces (per API Changes v1 §3), the Vault and Vaults classes, and the barrel. Vault implements getters, url(), toJSON(), and freeze/archive REST plumbing; createWallet, member, and share methods are stubbed for WCN-1203/WCN-1204. Vaults lifecycle methods (createVault, initialize, finalize, list, get) are stubbed pending Phase 2/3 (WCN-1175/1177). Wires an Enterprise.vaults() accessor and the bitgo barrel export.
WCN-1192
TICKET: WCN-1192